Get Files via FTP
Description
Get Files via FTP downloads one or more files from a remote FTP server to a local directory. Use this process entry when your process needs to retrieve data feeds, reports, or input files from an FTP server — for example, downloading daily transaction files for processing or pulling configuration files from a central server. It supports wildcard filtering, post-retrieval actions like deleting or moving remote files, and options for date-based filename renaming.
Note: Some FTP servers do not allow files to be FTP'ed when they contain certain characters (spaces for example). Therefore, when choosing filenames for files to be FTP'ed, be sure to check upfront whether your particular FTP server is able to process your kind of filenames.
Configurations
| Field Name | Description |
|---|---|
| Process Entry name | Specify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name. |
| Server: | |
| FTP server name / IP address | The name of the SFTP server or the IP address |
| Server Port | The TCP port to use. This is usually 22 |
| User name | The user name to log into the SFTP server |
| Password | The password to log into the SFTP server |
| Proxy type | Select from the list: HTTP/SOCKS5 |
| Proxy host | Proxy server host name |
| Proxy port | Proxy server port number |
| Proxy username | Proxy server account user name |
| Proxy password | Proxy server account password |
| Advanced: | |
| Binary mode? | Enable if files must be transferred in binary mode |
| Timeout | The FTP server timeout in seconds |
| Use active FTP connection | Enable if you are connecting to the FTP server using Active mode; you must set your firewall to accept connections to the port that your FTP client will open. The default is Passive mode. |
| Control encoding | Encoding matters when retrieving file names that contain special characters. For Western Europe and the USA, ISO-8859-1 usually suffices. Select encoding that is valid for your server. |
| Files tab: | |
| Process Entry name | Specify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name. |
| Remote: | |
| Remote Directory | The remote directory on the SFTP server from which we get the files. Use the "test folder" button to connect to the remote server and validate that the folder exists. |
| Wildcard (regular expression) | Specify a regular expression here if you want to select multiple files. |
| Remove files after retrieval? | Delete the remote file after the file is transferred. |
| Move files after retrieval? | Enable checkbox to move files after retrieval |
| Move to a folder | Moves files to specified folder |
| Create a folder | Creates folder that will contain files |
| Local: | |
| Target Directory | The remote directory on the SFTP server from which we get the files. Use the "test folder" button to connect to the remote server and validate that the folder exists. |
| Include date in filename | Adds the system date to the filename (_20101231) |
| Include time in filename | Adds the system time to the filename (_235959) |
| Specify date time format | Enable to provide your own date/time format; the default is yyyyMMdd'_'HHmmss |
| Date time format | Select date time format |
| Add date before extension | Adds date to the file name before the extension |
| Don't overwrite files | Enable to skip, rename, or fail if a file with an identical name already exists in the target directory |
| If file exists | Action to take if a file with an identical name already exists in the target directory |
| Add filenames to result | If checked the name of the file is added to the result stream. |
| Advanced tab | |
| Success Condition: | |
| Success on | Sets conditions of success |
| Limit files | Sets number of files associated with a condition of success |
| Socks Proxy Tab | |
| Proxy: | |
| Host | Socks Proxy host name |
| Port | Socks Proxy port number |
| Username | User name associated with the Socks Proxy account |
| Password | Password associated with the Socks Proxy account |